<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.app.movie.Movie</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.app-module.html">Package&nbsp;app</a> ::
        <a href="py2ecotect.app.movie-module.html">Module&nbsp;movie</a> ::
        Class&nbsp;Movie
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.app.movie.Movie-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Movie</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Movie</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.movie.Movie-class.html#add_frame" class="summary-sig-name">add_frame</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Call this command to add a new frame to the movie.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.add_frame">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.movie.Movie-class.html#finish" class="summary-sig-name">finish</a>(<span class="summary-sig-arg">self</span>)</span><br />
      This command MUST be called in order to finish recording the current 
      movie.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.finish">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.movie.Movie-class.html#play" class="summary-sig-name">play</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Call this command to play a movie in Windows Media Player, or to view
      an image.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.play">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.movie.Movie-class.html#record" class="summary-sig-name">record</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Use this command to begin recording a movie.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.record">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.movie.Movie-class.html#show" class="summary-sig-name">show</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      Use this command to show or hide the movie dialog box.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.show">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.movie.Movie-class.html#get_size" class="summary-sig-name">get_size</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the size of the screen currently being used to record the 
      animation.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.get_size">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.movie.Movie-class.html#set_size" class="summary-sig-name">set_size</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">width</span>,
        <span class="summary-sig-arg">height</span>)</span><br />
      Sets the size of the ECOTECT application window to use for the 
      animation recording.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.set_size">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.movie.Movie-class.html#aero_3d" class="summary-name">aero_3d</a><br />
      Determines whether the Windows Vista Aero theme is using 3D desktop 
      composition.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.movie.Movie-class.html#capture" class="summary-name">capture</a><br />
      Retrieves the current capture settings by which frames are added to 
      the animation, as shown in the table below.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.movie.Movie-class.html#filename" class="summary-name">filename</a><br />
      Retrieves the current pathname of the file to which the movie will be
      recorded.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.movie.Movie-class.html#frame_rate" class="summary-name">frame_rate</a><br />
      Retrieves the current movie playback speed, measured in frames per 
      second.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.movie.Movie-class.html#source" class="summary-name">source</a><br />
      Controls what appears inside the animation or each frame of the 
      recording.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.movie.Movie-class.html#type" class="summary-name">type</a><br />
      Returns the file format used to output the animation recording, as 
      shown in the Movie Types table below.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="add_frame"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_frame</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.add_frame">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Call this command to add a new frame to the movie. You can call this 
  command anytime whilst you are recording, regardless of the current 
  capture settings. Calls to this command when not recording are 
  ignored.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="finish"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">finish</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.finish">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This command MUST be called in order to finish recording the current 
  movie. If you do not, recording will continue until you manually click 
  the Finish button in the Create Animation dialog.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="play"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">play</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.play">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Call this command to play a movie in Windows Media Player, or to view 
  an image.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename The path and filename of the movie to play, and updates the 
  value of the filename edit field. If this parameter is not given, the 
  current filename in the Create Animation dialog is used.</p>
  <p>Be aware of the issues with backslashes in filename parameters as 
  described here.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="record"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">record</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.record">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to begin recording a movie.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename The path and filename to use for saving the recorded movie. 
  If this parameter is not given, the current filename in the Create 
  Animation dialog is used. Note: There are many parameters of the movie 
  that cannot be changed whilst actually recording. Thus, these parameters 
  are only read and applied when this command is called.</p>
  <p>Be aware of the issues with backslashes in filename parameters as 
  described here.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="show"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">show</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.show">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to show or hide the movie dialog box. This command is
  useful if you need to hide it so as not to obstruct part of the main 
  window during an animation.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>[state] Set this parameter to true to display the movie dialog box and
  false to hide it.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_size"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_size</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.get_size">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the size of the screen currently being used to record the 
  animation. When retrieving this property, an additional resize parameter 
  is returned before the width and height. This parameter is 1 when the 
  Specific Size: option is selected, and 0 when the Same as Source option 
  is selected, under the Create New Animation dialog box.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>resize A boolean value that indicates whether the movie resizes to fit
  the current window size. It is 1 when the Specific Size: option is 
  selected, and 0 when the Same as Source option is selected, under the 
  Create New Animation dialog box.</p>
  <p>width The width used for the animation recording, given in pixels.</p>
  <p>height The height used for the animation recording, given in 
  pixels.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_size"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_size</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">width</span>,
        <span class="sig-arg">height</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.movie-pysrc.html#Movie.set_size">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the size of the ECOTECT application window to use for the 
  animation recording. If the movie.source property is set to Main Window, 
  the width and height parameters refer to the overall dimensions of the 
  main application window. Otherwise, the main window is adjusted so that 
  only the drawing canvas is set to the specified size.</p>
  <p>Note that the ECOTECT application window does not adjust until the 
  movie.record command is called. If you wish to resize the application 
  window without creating an animation recording, this can be achieved 
  using the set.view.size, set.opengl.size, set.graph.size or 
  set.app.window commands.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>width Sets the width to use for the animation recording, measured in 
  pixels. height Sets the height to use for the animation recording, 
  measured in pixels.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="aero_3d"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">aero_3d</h3>
  <p>Determines whether the Windows Vista Aero theme is using 3D desktop 
  composition. Desktop composition within the Aero theme uses the 3D 
  graphics buffer to generate blurred transparency and 3D overlay effects. 
  With Aero enabled, ECOTECT must completely re-render the OpenGL image 
  each time a new screenshot or animation frame is required. Use this 
  property to determine if Aero is currently running in Vista. If you do 
  not use Aero or Vista, the result will always be false.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state This is a boolean value where 1 or true represents the 
  affirmative and 0 or false is negative.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Determines whether the Windows Vista Aero theme is using 3D desktop 
composition.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>)</span>
        - Enable or disable 3D desktop composition in the Windows Vista Aero theme.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="capture"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">capture</h3>
  <p>Retrieves the current capture settings by which frames are added to 
  the animation, as shown in the table below. Note that you can change 
  methods any time during the recording of an animation. For example, you 
  could choose to manually add the first few frames, then switch to each 
  redraw while you run a shadow or ray animation, and then switch to the 
  timer option as you move around the results.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>type An integer value from the Movie Capture Options table below, 
  representing capture settings used during recording.</p>
  <p>Relevant Data Table(s)</p>
  <p>Movie Capture Options Token Value Description manual 0 Manually redraw
  1 On Each Redraw timer 2 On Timer</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current capture settings by which frames are added to the 
animation, as shown in the table below.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the current capture settings by which frames are added to the 
animation recording.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="filename"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">filename</h3>
  <p>Retrieves the current pathname of the file to which the movie will be 
  recorded.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>filename A text string containing the filename and directory where 
  animations are currently recorded.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current pathname of the file to which the movie will be 
recorded.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>)</span>
        - Retrieves the current pathname of the file to which the movie will be 
recorded.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="frame_rate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">frame_rate</h3>
  <p>Retrieves the current movie playback speed, measured in frames per 
  second.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>fps The number of frames per second.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current movie playback speed, measured in frames per second.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">parameter</span>)</span>
        - Sets the number of frames that are recorded per second for the current 
animation.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="source"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">source</h3>
  <p>Controls what appears inside the animation or each frame of the 
  recording. The possible values returned are shown in the Movie Source 
  Options table below.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>src The source used for the animation or frame recording, as outlined 
  in the Movie Source Options table below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Movie Source Options Token Value Description canvas 0 Canvas Only 
  window 1 Main Window</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Controls what appears inside the animation or each frame of the recording.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">src</span>)</span>
        - The movie.source property controls what appears inside the animation or 
each frame of the recording.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">type</h3>
  <p>Returns the file format used to output the animation recording, as 
  shown in the Movie Types table below.</p>
  <p>When set to 0 (avi), the result is a single movie file. When set to 1 
  (bmp) or 2 (jpg), the result is a series of image files for each frame of
  the animation. The filename specified in the movie.record command is used
  as the base for each frame, with the frame number appended to it. The 
  filename displayed in the Create New Animation dialog box will also be 
  updated as the frame number increments.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>type The file format used for the animation recording output, as 
  outlined in the following Movie Types table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Movie Types Token Value Description avi 0 AVI Movie bmp 1 
  Bitmap Files jpg 2 JPEG Files</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the file format used to output the animation recording, as shown in
the Movie Types table below.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the file format used to output the animation recording.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
